SF2File Class

The SF2File class is used to pack a SF2 file to a SFPack file. You can create a SF2File Object with the Engine.OpenSF2 method.

Methods and Properties:

Method/Property

Description

Cancel ()

Call from within the Event.Progress event to cancel the current packing.

Error As SFPackErrorConst [R]

Get the current Error status of the object.

ErrorStr As String [R]

Returns the current Error status as a descriptive text.

File As String [R]

Returns the file the SF2File Object has been opened for (via Engine.OpenSF2). This is also the default property.

License As String [RW]

Allows you to set or read the License Text that should be attached to the SFPack File.

Pack (cFile as String, [ptType As SFPackTypeConst = ptMaximum]) As Long

Pack the SF2 file to a SFPack file and specify optional the compression method.
Returns 0 on failure (you can use the Error, ErrorStr properties to get further information).

Visual Basic Source Example

Password As String [RW]

Returns or sets the encryption password.

Size As Long [R]

Returns the size of the SF2 File in bytes.

Text As String [RW]

Allows you to set or read the Text information that should be attached to the SFPack file.